Users may wish to implement custom business monitoring. A common approach is to write specific events to Logstash and set up Kibana-based dashboards. To facilitate the integration of Orchestra and Logstash, signals can be defined as "relevant for Logstash." When such a signal is sent, it and all its associated data are automatically forwarded to Logstash.
The Logstash writer can be activated in the settings of the Orchestra monitor. Currently, up to five different signals can be designated as "relevant." The following table describes the available configuration parameters. If data cannot be immediately written to the Logstash server, a retry is scheduled. If the number of retries exceeds a specific limit, the data is written to a local file. This file can subsequently be used to manually import the data into Logstash.
When a signal is sent by a Process Model, the Logstash writer automatically captures the signal data and transmits it as JSON to the Logstash endpoint. The values carried by the signal are included in the JSON. Messages are encoded to Base64 content.
General Settings of the Logstash Writer
| Parameter | Description |
|---|
| config.threads | The number of threads used for parallel sending. |
| config.buffer.size | The maximum size of events that are buffered in case of queue congestion. If the queue is full, records will be written to the file system. |
| activated | Indicates whether the Logstash writer should process records. |
| config.backup.path | The base path of the directory that contains the Logstash files. |
| default.url | The default URL of the Logstash server that receives signal data as a JSON message. This URL is used when no signal-specific URL is configured. |
| default.user | The standard username for Logstash login. This username is used when no signal-specific URL is configured. |
| default.password | The standard password for Logstash login. This password is used when no signal-specific URL is configured. |
| retrycount | The maximum number of retries allowed in the event of an error. |
| error.delay | The wait timeout between the repetition of an erroneous call. |
| tcp.connect.timeout | The timeout (in seconds) value for establishing a TCP connection. |
| tcp.read.timeout | The timeout (in seconds) value for TCP communication. |
Settings for the First User-Defined Logstash Signal
| Parameter | Description |
|---|
| config.signal2.namespace | The namespace of the signal used for monitoring purposes. If left empty, the default namespace "urn:service:signal:logstash" is used. |
| config.signal2.name | The name of the signal used for monitoring purposes. If left empty, the default name "signal2" is used. |
| config.signal2.logstash.url | The URL of the Logstash server that receives the signal data as a JSON message. |
| config.signal2.logstash.username | The username used for Logstash login. |
| config.signal2.logstash.password | The password used for Logstash login. |
Settings for the Third User-Defined Logstash Signal
| Parameter | Description |
|---|
| config.signal3.namespace | The namespace of the signal used for monitoring purposes. If left empty, the default namespace "urn:service:signal:logstash" is used. |
| config.signal3.name | The name of the signal used for monitoring purposes. If left empty, the default name "signal3" is used. |
| config.signal3.logstash.url | The URL of the Logstash server that receives the signal data as a JSON message. |
| config.signal3.logstash.username | The username used for Logstash login. |
| config.signal3.logstash.password | The password used for Logstash login. |
Settings for the Fourth User-Defined Logstash Signal
| Parameter | Description |
|---|
| config.signal4.namespace | The namespace of the signal used for monitoring purposes. If left empty, the default namespace "urn:service:signal:logstash" is used. |
| config.signal4.name | The name of the signal used for monitoring purposes. If left empty, the default name "signal4" is used. |
| config.signal4.logstash.url | The URL of the Logstash server that receives the signal data as a JSON message. |
| config.signal4.logstash.username | The username used for Logstash login. |
| config.signal4.logstash.password | The password used for Logstash login. |
Settings for the Fifth User-Defined Logstash Signal
| Parameter | Description |
|---|
| config.signal5.namespace | The namespace of the signal used for monitoring purposes. If left empty, the default namespace "urn:service:signal:logstash" is used. |
| config.signal5.name | The name of the signal used for monitoring purposes. If left empty, the default name "signal5" is used. |
| config.signal5.logstash.url | The URL of the Logstash server that receives the signal data as a JSON message. |
| config.signal5.logstash.username | The username used for Logstash login. |
| config.signal5.logstash.password | The password used for Logstash login. |